Objects.ItemsByKey

This topic applies to Windows XP Home Edition and Windows XP Professional only.

The ItemsByKey property retrieves a sorted collection of objects that meet the specified criteria.

Syntax

objObjects.ItemsByKey(
  pproptype As MetaPropertyType,
  pprovider As GuideDataProvider,
  idLang As Long,
  vt As Long) As Objects

Parameters

pproptype

[in]  Specifies a MetaPropertyType object. Only objects containing a metaproperty of this type are retrieved.

pprovider

[in]  Specifies a GuideDataProvider object. Only objects associated with this data provider are retrieved. This parameter can be Nothing.

idLang

[in]  Specifies the language. A value of 0 specifies any language.

vt

[in]  Specifies the Variant subtype of the metaproperty value. Only objects whose matching metaproperty is of this type are retrieved.

Error Codes

If the property fails, an error is raised and Err.Number is set to a value other than zero.

Return Values

This property returns an Objects object.

Remarks

The retrieved collection is sorted by the metaproperty value. Use Objects.ItemWithKey to retrieve the first item whose key matches a particular value.

See Also

• Objects Object